Body structure (JSON)
Required fields are in bold.
| Field | Example | Type and format | Comments |
| { | |||
| "zNumber" | 4, | int | shift number, should be unique for deviceID |
| "fiscalNum" | 70113, | int | |
| "firstNumber" | 1, | int | number of the first document from the shift |
| "lastNumber" | 1, | int | number of the last document from the shift |
| "cashier" | "Cashier 1", | string | name of the cashier |
| "dateTime" | "2025-01-02T10:25:21.076Z", | dateTime of ISO-8601 format | should be less or equal than the first document dateTime + shift length |
| "currency" | "UAH", | string | |
| "msgId" | 16, | int | |
| "totals" | |||
| { | |||
| "sale" | |||
| { | |||
| "count" | 17, | int | |
| "amount" | 223000 | int | should be equal to the sum of all payments for the sale |
| }, | |||
| "deposit" | |||
| { | |||
| "count" | 1, | int | |
| "amount" | 10000 | int | |
| }, | |||
| "refund" | |||
| { | |||
| "count" | 1, | int | |
| "amount" | 10000 | int | should be equal to the sum of all payments for the refund |
| }, | |||
| "withdraw" | { … }, | same fields as the for the sale, deposit and refund | |
| }, | |||
| "payments" | |||
| { | |||
| "sale" | |||
| [ | |||
| { | |||
| "type" | "CASH", | string | type of payment |
| "amount" | 223000 | int | |
| }, | |||
| ], | |||
| "refund" | |||
| [ | |||
| { | |||
| "type" | "CARD", | string | |
| "amount" | 2300 | int | |
| } | |||
| ] | |||
| }, | |||
| "taxTotals" | |||
| { | |||
| "sale" | |||
| [ | |||
| { | |||
| "taxCode" | "A", | string | |
| "taxRate" | 2000, | int | |
| "taxAmount" | 15600 | int | |
| } | |||
| ], | |||
| "refund" | |||
| [ | |||
| { | |||
| "taxCode" | "A", | string | |
| "taxRate" | 2000, | int | |
| "taxAmount" | 1600 | int | |
| } | |||
| ], | |||
| }, | |||
| "identity" | |||
| { | |||
| "fn" | "567765", | string | device token |
| "tin" | "1111111111", | string | |
| "shopName" | "SHOP #1", | string | |
| "shopAddress" | "Unknown st., 404" | string | |
| }, | |||
| "location" | optional | ||
| { | |||
| "latitude" | 6.500183676689106, | float | |
| "longitude" | 120.76210479216934, | float | |
| "radius" | 1000 | int | |
| } | |||
| } |
Example:
{
"zNumber": 4,
"fiscalNum": 70113,
"firstNumber": 1,
"lastNumber": 1,
"cashier": "Cashier 1",
"dateTime": "2025-01-02T10:25:21.076Z",
"currency": "UAH",
"msgId": 16,
"totals": {
"sale": {
"count": 17,
"amount": 223000
},
"deposit": {
"count": 1,
"amount": 10000
},
"refund": {
"count": 1,
"amount": 10000
},
"withdraw": {
"count": 0,
"amount": 0
}
},
"payments": {
"sale": [
{
"type": "CASH",
"amount": 223000
}
],
"refund": [
{
"type": "CARD",
"amount": 2300
}
]
},
"taxTotals": {
"sale": [
{
"taxCode": "A",
"taxRate": 2000,
"taxAmount": 1600
}
],
"refund": [
{
"taxCode": "A",
"taxRate": 2000,
"taxAmount": 1600
}
]
},
"identity": {
"fn": "567765",
"tin": "1111111111",
"shopName": "SHOP #1",
"shopAddress": "Unknown st., 404"
},
"location": {
"latitude": 6.500183676689106,
"longitude": 120.76210479216934,
"radius": 1000
}
}